Skip to content

Add new map types#3147

Closed
refortie wants to merge 1 commit intoAzure:masterfrom
refortie:add-new-map-types
Closed

Add new map types#3147
refortie wants to merge 1 commit intoAzure:masterfrom
refortie:add-new-map-types

Conversation

@refortie
Copy link
Copy Markdown
Contributor

@refortie refortie commented May 29, 2018 •
edited by azuresdkci
Loading

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

  • The title of the PR is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
  • Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
  • If applicable, the PR references the bug/issue that it fixes.
  • Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

@azuresdkci azuresdkci requested a review from hovsepm May 29, 2018 20:47
@AutorestCI
Copy link
Copy Markdown

AutorestCI commented May 29, 2018 •
edited
Loading

Automation for azure-libraries-for-java

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
AutorestCI/azure-libraries-for-java#139

This was referenced May 29, 2018
Closed
Closed
@AutorestCI
Copy link
Copy Markdown

AutorestCI commented May 29, 2018 •
edited
Loading

Automation for azure-sdk-for-node

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
Azure/azure-sdk-for-node#2830

@AutorestCI AutorestCI mentioned this pull request May 29, 2018
Closed
@AutorestCI
Copy link
Copy Markdown

AutorestCI commented May 29, 2018 •
edited
Loading

Automation for azure-sdk-for-python

A PR has been created for you:
Azure/azure-sdk-for-python#2653

@AutorestCI AutorestCI mentioned this pull request May 29, 2018
Closed
@AutorestCI
Copy link
Copy Markdown

AutorestCI commented May 29, 2018 •
edited
Loading

Automation for azure-sdk-for-ruby

A PR has been created for you:
Azure/azure-sdk-for-ruby#1326

@AutorestCI AutorestCI mentioned this pull request May 29, 2018
Closed
@AutorestCI
Copy link
Copy Markdown

AutorestCI commented May 29, 2018 •
edited
Loading

Automation for azure-sdk-for-go

A PR has been created for you:
Azure/azure-sdk-for-go#1983

@hovsepm
Copy link
Copy Markdown
Contributor

hovsepm commented May 29, 2018 •
edited
Loading 

     "MapType": {
+      "description": "The map type of integration account map.",
       "type": "string",
       "enum": [
         "NotSpecified",
        "Xslt",
+       "Xslt20",
+       "Xslt30",
+       "Liquid"
       ],
       "x-ms-enum": {
         "name": "MapType",
         "modelAsString": false
       }

Since your Enum was modeled with "modelAsString": false - adding new values to Enum types will cause breaking changes in generated strongly typed languages (e.g. .Net, Java etc). It is recommended to update your API version and if you expect more changes in the future for this enum - change modeling to "modelAsString": true . It will change this type to string values (still a breaking change) but in the future modifications in the enum will not be breaking.

Refers to: specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json:6321 in 913cec9. [](commit_id = 913cec9, deletion_comment = False)

@refortie
Copy link
Copy Markdown
Contributor Author

refortie commented May 29, 2018 •
edited
Loading

Since your Enum was modeled with "modelAsString": false - adding new values to Enum types will cause breaking changes in generated strongly typed languages (e.g. .Net, Java etc). It is recommended to update your API version and if you expect more changes in the future for this enum - change modeling to "modelAsString": true . It will change this type to string values (still a breaking change) but in the future modifications in the enum will not be breaking.

To add a new version I would create a new folder at specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01.1.0 or should I be doing a newer date?

@hovsepm
Copy link
Copy Markdown
Contributor

hovsepm commented May 30, 2018

@refortie new API version is not just a new folder in swagger spec repo. Your service should be upgraded to the new API version and deployed across all the available regions.

@refortie refortie closed this Jun 6, 2018
@sarangan12 sarangan12 removed the review label Jun 6, 2018
@refortie refortie deleted the add-new-map-types branch June 6, 2018 21:09
@AutorestCI AutorestCI mentioned this pull request Jun 6, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hovsepm hovsepm Awaiting requested review from hovsepm

Assignees

@hovsepm hovsepm

Labels

potential-sdk-breaking-change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@refortie @AutorestCI @hovsepm @sarangan12